20 编程风格(ECMAScript6入门)

发表于   |   分类于   |  

参考：主要参考了 Airbnb 的 JavaScript 风格规范
扩展：推荐两个代码风格检查工具

20.1 块级作用域

###（1） let 取代 var

  • let 不存在变量提升
  • let 支持块级作用域
  • let 不会误声明全局变量
1
2
3
4
5
6
7
8
9
'use strict';

if (true) {
  let x = 'hello';
}

for (let i = 0; i < 10; i++) {
  console.log(i);
}

（2）全局常量和线程安全

说明： 在 let 和 const 之间，尽可能使用 const，理由如下

  • 全局环境不应该设计 变量，只应该设置 常量（符合函数式编程思想，有利于将来的分布式运算）
  • 阅读代码的人立刻会意识到不应该修改这个值
  • 防治了无意间修改变量所导致的错误
  • 所有的函数都应该设置为常量
  • 长远来看，JavaScript 有可能会有多线程的实现，使用 const 有利于保证线程安全
1
2
3
4
5
6
7
8
9
10
// bad
var a = 1, b = 2, c = 3;

// good
const a = 1;
const b = 2;
const c = 3;

// best
const [a, b, c] = [1, 2, 3];

20.2 字符串

说明：字符串分两类

  • 静态字符串：使用 单引号 '' 或反引号
  • 动态字符串：使用反引号
1
2
3
4
5
6
7
8
9
10
11
// bad
const a = "foobar";
const b = 'foo' + a + 'bar';

// acceptable
const c = `foobar`;

// good
const a = 'foobar';
const b = `foo${a}bar`;
const c = 'foobar';

20.3 解构赋值

说明：分两种情况，对象解构赋值 和 数组解构赋值

对象的解构赋值

说明：优先使用对象的解构赋值的场景

  • 函数的参数如果是对象的成员
  • 函数返回多个值（便于以后添加返回值，以及更改返回值的顺序）

Demo1: 函数的参数如果是对象的成员

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// bad
function getFullName(user) {
  const firstName = user.firstName;
  const lastName = user.lastName;
}

// good
function getFullName(obj) {
  const { firstName, lastName } = obj;
}

// best
function getFullName({ firstName, lastName }) {
}

Demo2: 函数返回多个值

1
2
3
4
5
6
7
8
9
10
11
// bad
function processInput(input) {
  return [left, right, top, bottom];
}

// good
function processInput(input) {
  return { left, right, top, bottom };
}

const { left, right } = processInput(input);

数组的解构赋值

说明：优先使用数组的结构赋值的场景

  • 使用数组成员对变量赋值时

Demo1: 使用数组成员对变量赋值时

1
2
3
4
5
6
7
8
const arr = [1, 2, 3, 4];

// bad
const first = arr[0];
const second = arr[1];

// good
const [first, second] = arr;

20.4 对象

  1. 单行定义的对象，最后一个成员不以逗号结尾
  2. 多行定义的对象，最后一个成员以逗号结尾
  3. 对象尽量静态化，一旦定义，就不得随意添加新的属性。如果添加属性不可避免，要使用 Object.assign 方法。
  4. 如果对象的属性名是动态的，可以在创造对象的时候，使用属性表达式定义
  5. 对象的属性和方法，尽量采用简洁表达法，这样易于描述和书写

Demo1: 单行定义的对象，最后一个成员不以逗号结尾

1
2
3
4
5
// bad
const a = { k1: v1, k2: v2, };

// good
const a = { k1: v1, k2: v2 };

Demo2: 多行定义的对象，最后一个成员以逗号结尾

1
2
3
4
5
6
7
8
9
10
11
// bad
const b = {
  k1: v1,
  k2: v2
};

// good
const b = {
  k1: v1,
  k2: v2,
};

Demo3: 对象尽量静态化，一旦定义，就不得随意添加新的属性

1
2
3
4
5
6
7
8
9
10
11
// bad
const a = {};
a.x = 3;

// if reshape unavoidable
const a = {};
Object.assign(a, { x: 3 });

// good
const a = { x: null };
a.x = 3;

Demo4: 如果对象的属性名是动态的，可以在创造对象的时候，使用属性表达式定义

1
2
3
4
5
6
7
8
9
10
11
12
13
// bad
const obj = {
  id: 5,
  name: 'San Francisco',
};
obj[getKey('enabled')] = true;

// good
const obj = {
  id: 5,
  name: 'San Francisco',
  [getKey('enabled')]: true,
};

Demo5: 对象的属性和方法，尽量采用简洁表达法，这样易于描述和书写

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
var ref = 'some value';

// bad
const atom = {
  ref: ref,

  value: 1,

  addValue: function (value) {
    return atom.value + value;
  },
};

// good
const atom = {
  ref,

  value: 1,

  addValue(value) {
    return atom.value + value;
  },
};

20.5 数组

  1. 使用扩展运算符 ... 拷贝数组
  2. 使用 Array.from 方法，将类似数组的对象转为数组

Demo1: 使用扩展运算符（…）拷贝数组

1
2
3
4
5
6
7
8
9
10
11
// bad
const len = items.length;
const itemsCopy = [];
let i;

for (i = 0; i < len; i++) {
  itemsCopy[i] = items[i];
}

// good
const itemsCopy = [...items];

Demo2: 使用 Array.from 方法，将类似数组的对象转为数组

1
2
const foo = document.querySelectorAll('.foo');
const nodes = Array.from(foo);

20.6 函数

注意：简单的、单行的、不会复用的函数，建议采用箭头函数。如果函数体较为复杂，行数较多，还是应该采用传统的函数写法。

  1. 立即执行函数可以写成箭头函数的形式
  2. 那些需要使用函数表达式的场合，尽量用箭头函数代替。因为这样更简洁，而且绑定了this
  3. 箭头函数取代 Function.prototype.bind，不应再用 self/_this/that 绑定 this
  4. 所有配置项都应该集中在一个对象，放在最后一个参数，布尔值不可以直接作为参数
  5. 不要在函数体内使用arguments变量，使用rest运算符（…）代替（提供一个真正的数组）
  6. 使用默认值语法设置函数参数的默认值

Demo1: 立即执行函数可以写成箭头函数的形式

1
2
3
(() => {
  console.log('Welcome to the Internet.');
})();

Demo2: 那些需要使用函数表达式的场合，尽量用箭头函数代替。因为这样更简洁，而且绑定了this

1
2
3
4
5
6
7
8
9
10
11
12
// bad
[1, 2, 3].map(function (x) {
  return x * x;
});

// good
[1, 2, 3].map((x) => {
  return x * x;
});

// best
[1, 2, 3].map(x => x * x);

Demo3: 箭头函数取代 Function.prototype.bind，不应再用 self/_this/that 绑定 this

1
2
3
4
5
6
7
8
9
10
11
// bad
const self = this;
const boundMethod = function(...params) {
  return method.apply(self, params);
}

// acceptable
const boundMethod = method.bind(this);

// best
const boundMethod = (...params) => method.apply(this, params);

Demo4: 所有配置项都应该集中在一个对象，放在最后一个参数，布尔值不可以直接作为参数

1
2
3
4
5
6
7
// bad
function divide(a, b, option = false ) {
}

// good
function divide(a, b, { option = false } = {}) {
}

Demo5: 不要在函数体内使用arguments变量，使用rest运算符（…）代替（提供一个真正的数组）

1
2
3
4
5
6
7
8
9
10
// bad
function concatenateAll() {
  const args = Array.prototype.slice.call(arguments);
  return args.join('');
}

// good
function concatenateAll(...args) {
  return args.join('');
}

Demo6: 使用默认值语法设置函数参数的默认值

1
2
3
4
5
6
7
8
9
// bad
function handleThings(opts) {
  opts = opts || {};
}

// good
function handleThings(opts = {}) {
  // ...
}

20.7 Map结构

说明： 注意区分 Object 和 Map，只有模拟现实世界的实体对象时，才使用 Object。如果只是需要 key: value 的数据结构，使用 Map 结构。因为 Map 有内建的遍历机制。

1
2
3
4
5
6
7
8
9
10
11
12
13
let map = new Map(arr);

for (let key of map.keys()) {
  console.log(key);
}

for (let value of map.values()) {
  console.log(value);
}

for (let item of map.entries()) {
  console.log(item[0], item[1]);
}

20.8 Class

  1. 总是用 Class ，取代需要 prototype 的操作。因为 Class 的写法更简洁，更易于理解。
  2. 使用 extends 实现继承，因为这样更简单，不会有破坏 instanceof 运算的危险。

Demo1: 总是用 Class ，取代需要 prototype 的操作。因为 Class 的写法更简洁，更易于理解。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// bad
function Queue(contents = []) {
  this._queue = [...contents];
}
Queue.prototype.pop = function() {
  const value = this._queue[0];
  this._queue.splice(0, 1);
  return value;
}

// good
class Queue {
  constructor(contents = []) {
    this._queue = [...contents];
  }
  pop() {
    const value = this._queue[0];
    this._queue.splice(0, 1);
    return value;
  }
}

Demo2: 使用 extends 实现继承，因为这样更简单，不会有破坏 instanceof 运算的危险。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// bad
const inherits = require('inherits');
function PeekableQueue(contents) {
  Queue.apply(this, contents);
}
inherits(PeekableQueue, Queue);
PeekableQueue.prototype.peek = function() {
  return this._queue[0];
}

// good
class PeekableQueue extends Queue {
  peek() {
    return this._queue[0];
  }
}

20.9 模块

说明： Module 语法是 JavaScript 模块的标准写法，坚持使用这种写法

  1. 使用 import 取代 require
  2. 使用 export 取代 module.exports（如果模块只有一个输出值，就使用 export default，如果模块有多个输出值，就不使用 export default，不要 export default 与普通的 export 同时使用）
  3. 不要在模块输入中使用通配符
  4. 如果模块默认输出一个函数，函数名的首字母应该小写
  5. 如果模块默认输出一个对象，对象名的首字母应该大写

Demo1: 使用 import 取代 require

1
2
3
4
5
6
7
// bad
const moduleA = require('moduleA');
const func1 = moduleA.func1;
const func2 = moduleA.func2;

// good
import { func1, func2 } from 'moduleA';

Demo2： 使用 export 取代 module.exports（如果模块只有一个输出值，就使用 export default，如果模块有多个输出值，就不使用 export default，不要 export default 与普通的 export 同时使用）

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// commonJS的写法
var React = require('react');

var Breadcrumbs = React.createClass({
  render() {
    return <nav />;
  }
});

module.exports = Breadcrumbs;

// ES6的写法
import React from 'react';

const Breadcrumbs = React.createClass({
  render() {
    return <nav />;
  }
});

export default Breadcrumbs

Demo3: 不要在模块输入中使用通配符（你的模块之中，有一个默认输出）

1
2
3
4
5
// bad
import * as myObject './importModule';

// good
import myObject from './importModule';

Demo4: 如果模块默认输出一个函数，函数名的首字母应该小写

1
2
3
4
function makeStyleGuide() {
}

export default makeStyleGuide;

Demo5: 如果模块默认输出一个对象，对象名的首字母应该大写

1
2
3
4
5
6
const StyleGuide = {
  es6: {
  }
};

export default StyleGuide;

20.10 ESLint的使用

说明：ESLint 是一个语法规则和代码风格的检查工具，可以用来保证写出语法正确、风格统一的代码。

（1）安装

1
2
3
4
5
# 安装ESLint
$ npm i -g eslint

# 安装Airbnb语法规则
$ npm i -g eslint-config-airbnb

（2）.eslintrc 配置文件

1
2
3
{
  "extends": "eslint-config-airbnb"
}

（3）使用
index.js：有错误的代码

1
2
3
4
5
6
7
8
var unusued = 'I have no purpose!';

function greet() {
    var message = 'Hello, World!';
    alert(message);
}

greet();

检查

1
2
3
4
5
6
7
$ eslint index.js
index.js
  1:5  error  unusued is defined but never used                 no-unused-vars
  4:5  error  Expected indentation of 2 characters but found 4  indent
  5:5  error  Expected indentation of 2 characters but found 4  indent

✖ 3 problems (3 errors, 0 warnings)